.TH "Zebulon::Underwater::RabbitComponent" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::Underwater::RabbitComponent \- 
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBRabbitCallback\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBRabbitComponent\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~RabbitComponent\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual int \fBSetupService\fP ()"
.br
.RI "\fIReports what jaus messages we support. \fP"
.ti -1c
.RI "virtual int \fBInitialize\fP (const unsigned int delay=1000)"
.br
.RI "\fIInitialize communications thread, and jaus interface. \fP"
.ti -1c
.RI "virtual int \fBProcessCommandMessage\fP (const Jaus::Message *message, const Jaus::Byte authority)"
.br
.RI "\fIProcess command messages. \fP"
.ti -1c
.RI "virtual int \fBProcessQueryMessage\fP (const Jaus::Message *message)"
.br
.RI "\fIProcesss query messages. \fP"
.ti -1c
.RI "virtual int \fBGenerateEvent\fP (const Jaus::Event *eventInfo)"
.br
.RI "\fIConfirms the types of events this class will generate. \fP"
.ti -1c
.RI "virtual int \fBProcessEventRequest\fP (const Jaus::CreateEventRequest &command, Jaus::Byte &responseValue, double &confirmedRate, std::string &errorMessage) const "
.br
.RI "\fIConfirms the types of events this class will generate. \fP"
.ti -1c
.RI "void \fBSetMicroController\fP (\fBMCU::Interface\fP *microController)"
.br
.RI "\fISets the microcontroller we will be using to interface with sensors. \fP"
.ti -1c
.RI "bool \fBIsRabbitResponsive\fP ()"
.br
.ti -1c
.RI "void \fBPrintStatus\fP () const "
.br
.RI "\fIPrints status of component including important internal values. \fP"
.in -1c
.SH "Member Function Documentation"
.PP 
.SS "int RabbitComponent::GenerateEvent (const Jaus::Event * eventInfo)\fC [virtual]\fP"
.PP
Confirms the types of events this class will generate. \fBParameters:\fP
.RS 4
\fIcommand\fP 
.br
\fIresponseValue\fP 
.br
\fIconfirmedRate\fP 
.br
\fIerrorMessage\fP 
.RE
.PP

.SS "int RabbitComponent::ProcessEventRequest (const Jaus::CreateEventRequest & command, Jaus::Byte & responseValue, double & confirmedRate, std::string & errorMessage) const\fC [virtual]\fP"
.PP
Confirms the types of events this class will generate. \fBParameters:\fP
.RS 4
\fIcommand\fP 
.br
\fIresponseValue\fP 
.br
\fIconfirmedRate\fP 
.br
\fIerrorMessage\fP 
.RE
.PP

.SS "void RabbitComponent::SetMicroController (\fBMCU::Interface\fP * microController)"
.PP
Sets the microcontroller we will be using to interface with sensors. and devices.
.PP
\fBParameters:\fP
.RS 4
\fImicroController\fP interface to microcontroller we will use, in this case the rabbit. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
